Available Parameters

Parameter

Description

<number> or number=<number>

The number of the receiving mobile device. You can use the %number% server variable here.

data=<message>

The message you want to send. You can use the %data% server variable here. Not applicable for the sms: URI.

You can use the ;hex and ;b64 parameter modifiers here to convert the data to hexadecimal or base64 encoding and the ;len modifier to insert the length of the data into the beginning of the data (if required). See the next chapter for details. 

binary=<bin>

Used by system integrators for binary messages – ignore this unless you know what it is.

SMS gateway supports UDH, 7bit, 8bit and Unicode encoding. binary=1 indicates the message will carry a binary (8-bit) payload, and UDH must be constructed. By default it requires the <message> value to be base64 encoded and the <udh> value as well.

udh=<udh>

Used by system integrators for binary messages – ignore this unless you know what it is.

You can use the ;hex and ;b64 parameter modifiers here to convert the data to hexadecimal or base64 encoding and the ;len modifier to insert the length of the data into the beginning of the data (if required). See the next chapter for details. 

pid=<pid>

Used by system integrators for binary messages - ignore this unless you know what it is.

dcs=<dcs>

Used by system integrators for binary messages – ignore this unless you know what it is.

user=<username>

Valid username REQUIRED if authentication is active.

pass=<password>

Valid password for the supplied username REQUIRED if authentication is active.

maxmsgs=<N>

Maximum number of SMS that should be sent if the message is too long to fit one standard sized SMS message. When specified (an integer number), tells IceWarp Server to truncate the exceeding data and forward the first N standard SMS-sized blocks of data only. Allows you to control the maximum number of messages the long (concatenated, SAR) messages can consists of.

By default, when this parameter is not specified, HTTP request is not limited, sms: protocol messages are reduced to one standard message, and text messages sent through WebClient are limited to five standard-sized messages. If you want to forward a complete message, you should set this option to a bigger number, the maximum acceptable value is 128.

The text message <data> will be truncated according to this parameter and delivered as one concatenated message to the device. SMS gateway takes care of the concatenation with GSM modem, with remote HTTP gateway in use you might need to pass it also the %parts% server variable, which specifies how many standard-sized messages the %data% payload consists of.

Note: The maximum message body payload in the SAR specification is set to 2048 bytes, therefore the maximum value you should use is 12 – any longer message body can be truncated by the carrier, service provider or device itself.

Note: This parameter does not apply to an HTTP request. The application or script sending the request must take care of any truncation itself, or use options offered by the remote HTTP gateway or service provider.

sender=<sender>

The originating number. Allows to rewrite the sender's Caller ID so that the message will appear to recipient as sent from a number you specify here.

Note: This feature must be supported by the wireless carrier (GSM or HTTP service provider). If not supported or specified, the number associated with the SIM card or provider's account will be used.

authenticated=<authenticated>

Boolean value. "1" tells IceWarp Server that access to the gateway is already granted and authentication is to be skipped. If the parameter is "0" or omitted, authentication be evaluated before sending the message.

reply=<reply>

The sender's Reply-To address to be included in the message body, usually an email as this parameter is used by the Reply-To feature for bridging SMS and email. See Incoming Rules for details.

id=<ID>

Identifier of an SMS gateway in the case there are multiple gateways configured. It allows you to route messages to a specific gateway, for example by rules, to facilitate Least Cost Routing based on international/network prefix of the recipient's mobile number. Use hex encoding of HTML special chars (e.g. %20 for space). When not specified, the first available gateway is used (load-balancing).

value=<string>

Optional parameter which allows passing custom parameters that are interpreted by the destination gateway, not by IceWarp SMS server. For example, if you wish to pass unicode=1 parameter in HTTP request to a remote SMS gateway, you will specify value=&unicode=1.

You can use the value parameter multiple times inside the same request.